FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package hl7.fhir.uv.sdc#current (62 ms)

Package hl7.fhir.uv.sdc
Type CapabilityStatement
Id Id
FHIR Version R4
Source http://hl7.org/fhir/uv/sdc/https://build.fhir.org/ig/HL7/sdc/CapabilityStatement-sdc-form-filler.html
Url http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-filler
Version 4.0.0-ballot
Status active
Date 2014-07-06
Name SDCFormFiller
Title SDC Form Filler
Experimental False
Realm uv
Authority hl7
Description This profile defines the expected capabilities of the ''SDC Form Filler'' role when conforming to the S&I Framework's [[index.html|Structured Data Capture FHIR implementation guide]]. This role is responsible for retrieving pre-defined forms, requesting pre-population of forms and/or auto-populating forms, guiding the user through verifying populated data and submitting completed or partially-completed forms.
Note that Form Fillers may also take on the role of [[CapabilityStatement-sdc-form-archiver.html|Form Archiver]] if they have a requirement to retain the completed version of a form (and potentially the source data that was used to complete it).
Kind requirements

Resources that use this resource

CapabilityStatement
https://smartforms.csiro.au/ig/CapabilityStatement/SmartFormsApplication Smart Forms Application

Resources that this resource uses

OperationDefinition
Questionnaire-populate Populate Questionnaire
Questionnaire-populatehtml Generate HTML for Questionnaire
Questionnaire-populatelink Generate a link to a Questionnaire completion webpage
Questionnaire-populate Populate Questionnaire
Questionnaire-populatehtml Generate HTML for Questionnaire
Questionnaire-populatelink Generate a link to a Questionnaire completion webpage
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem SDC Code System
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire SDC Base Questionnaire
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse SDC Standard Questionnaire Response
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset SDC Value Set
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem SDCCodeSystem
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire SDCBaseQuestionnaire
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse SDC Questionnaire Response
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset SDC ValueSet


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement sdc-form-filler

SDC Form Filler

  • Implementation Guide Version: 4.0.0-ballot
  • FHIR Version: 1.0.0
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: 2014-07-06
  • Published by: HL7 International / FHIR Infrastructure

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: client

The [[Questionnaire]], [[ValueSet]] and [[CodeSystem]] resources are retrieved to allow the system to guide the user through the entry process. The [[Binary]] and [[DocumentReference]] resources allow the system to find existing clinical documents that can be within the pre-population process. (Support for retrieval operations on these resources is optional as the relevant CDA or FHIR structures may also be directly generated by the ''Form Filler'' itself.) Finally, the [[QuestionnaireResponse]] resource is used to record the populated form.<br/>Note: Form Fillers that support the 'populate' operation will need to be capable of consuming and rendering a partially completed QuestionnaireResponse in the same manner as if they had retrieved such a QuestionnaireResponse from a ''Form Response Manager''

Security

Implementations must meet the general security requirements documented in the [[security.html|SDC implementation guide]].

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)

Resource Conformance: SHALL Questionnaire

Base System Profile
SDC Base Questionnaire
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    search-type

    Allows discovery of existing questionnaires to be completed

  • SHOULD support
    read

    Allows retrieval of a specific questionnaire by id. Allows systems to maintain a 'favorites' list of forms and retrieve them by id.

  • MAY support
    history-instance

    Allows review of changes made to a questionnaire over time. Of interest to some systems, but probably not most.

    vread

    Allows retrieval of a historical version of a questionnaire. Most systems will make use of the current version only.

Resource Conformance: SHALL ValueSet

Base System Profile
SDC Value Set
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    read

    Allows retrieval of a specific value set by id (as referenced in a Questionnaire)

  • SHOULD support
    vread

    Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)

  • MAY support
    history-instance

    Allows review of changes to a value set over time. Of interest to some systems, but probably not most.

Resource Conformance: SHALL CodeSystem

Base System Profile
SDC Code System
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    read

    Allows retrieval of a specific code system by id (as referenced by a ValueSet used in a Questionnaire)

  • SHOULD support
    vread

    Allows retrieval of a specific version of a code system (as referenced by a ValueSet used in a Questionnaire)

  • MAY support
    history-instance

    Allows review of changes to a code system over time. Of interest to some systems, but probably not most.

Resource Conformance: SHALL QuestionnaireResponse

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    search-type

    Allows a user to search for existing completed or partially-completed forms. Generally used to find partially-completed forms for update.

    read

    Allows retrieval of a specific QuestionnaireResponse by id.

    create

    Allows recording a completed or partially-completed form

    update

    Allows updating an existing completed or partially-completed form. (Systems may place rules on who can update forms and under what circumstances.)

    delete

    Allows removal of a completed form from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove a completed form and under what circumstances.

  • SHOULD support
    history-instance

    Allows review of prior versions of an answer set - allows reversion to previously recorded versions

Resource Conformance: SHOULD DocumentReference

Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary
  • SHOULD support
    search-type

    Allows discovery of existing documents that may be included in a form pre-population request

Resource Conformance: SHOULD Binary

Core FHIR Resource
Binary
Reference Policy
Interaction summary
  • SHOULD support
    read

    Allows retrieval of a specific binary (as pointed to by a DocumentReference)

  • MAY support
    vread

    Allows retrieval of a historical version of a binary. In general, the most recent version would be appropriate, but some may prefer to use the specific version referenced by a DocumentReference.

Operations

Use


Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "sdc-form-filler",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement sdc-form-filler</b></p><a name=\"sdc-form-filler\"> </a><a name=\"hcsdc-form-filler\"> </a><a name=\"sdc-form-filler-en-US\"> </a><h2 id=\"title\">SDC Form Filler</h2><ul><li>Implementation Guide Version: 4.0.0-ballot </li><li>FHIR Version: 1.0.0 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2014-07-06 </li><li>Published by: HL7 International / FHIR Infrastructure </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>client</code></h3></div><div class=\"panel-body\"><div><p>The [[Questionnaire]], [[ValueSet]] and [[CodeSystem]] resources are retrieved to allow the system to guide the user through the entry process. The [[Binary]] and [[DocumentReference]] resources allow the system to find existing clinical documents that can be within the pre-population process. (Support for retrieval operations on these resources is optional as the relevant CDA or FHIR structures may also be directly generated by the ''Form Filler'' itself.) Finally, the [[QuestionnaireResponse]] resource is used to record the populated form.&lt;br/&gt;Note: Form Fillers that support the 'populate' operation will need to be capable of consuming and rendering a partially completed QuestionnaireResponse in the same manner as if they had retrieved such a QuestionnaireResponse from a ''Form Response Manager''</p>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>Implementations must meet the general security requirements documented in the [[security.html|SDC implementation guide]].</p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET past versions of resources (vread interaction)\">V-R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th class=\"text-center\"><b title=\"DELETE a resource (delete interaction)\">D</b></th><th class=\"text-center\"><b title=\"GET changes to a resource (history interaction on instance)\">H-I</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Questionnaire1-1\">Questionnaire</a></td><td><a href=\"StructureDefinition-sdc-questionnaire.html\">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr><tr><td><a href=\"#ValueSet1-2\">ValueSet</a></td><td><a href=\"StructureDefinition-sdc-valueset.html\">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr><tr><td><a href=\"#CodeSystem1-3\">CodeSystem</a></td><td><a href=\"StructureDefinition-sdc-codesystem.html\">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr><tr><td><a href=\"#QuestionnaireResponse1-4\">QuestionnaireResponse</a></td><td><a href=\"StructureDefinition-sdc-questionnaireresponse.html\">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse</a></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr><tr><td><a href=\"#DocumentReference1-5\">DocumentReference</a></td><td>�</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Binary1-6\">Binary</a></td><td>�</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Questionnaire1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Questionnaire</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-sdc-questionnaire.html\">SDC Base Questionnaire</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>search-type</code><div><p>Allows discovery of existing questionnaires to be completed</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>read</code><div><p>Allows retrieval of a specific questionnaire by id. Allows systems to maintain a 'favorites' list of forms and retrieve them by id.</p>\n</div></li><li><strong>MAY</strong> support <br/><code>history-instance</code><div><p>Allows review of changes made to a questionnaire over time. Of interest to some systems, but probably not most.</p>\n</div><code>vread</code><div><p>Allows retrieval of a historical version of a questionnaire. Most systems will make use of the current version only.</p>\n</div></li></ul></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"ValueSet1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>ValueSet</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-sdc-valueset.html\">SDC Value Set</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>read</code><div><p>Allows retrieval of a specific value set by id (as referenced in a Questionnaire)</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>vread</code><div><p>Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)</p>\n</div></li><li><strong>MAY</strong> support <br/><code>history-instance</code><div><p>Allows review of changes to a value set over time. Of interest to some systems, but probably not most.</p>\n</div></li></ul></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"CodeSystem1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>CodeSystem</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-sdc-codesystem.html\">SDC Code System</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>read</code><div><p>Allows retrieval of a specific code system by id (as referenced by a ValueSet used in a Questionnaire)</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>vread</code><div><p>Allows retrieval of a specific version of a code system (as referenced by a ValueSet used in a Questionnaire)</p>\n</div></li><li><strong>MAY</strong> support <br/><code>history-instance</code><div><p>Allows review of changes to a code system over time. Of interest to some systems, but probably not most.</p>\n</div></li></ul></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"QuestionnaireResponse1-4\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>QuestionnaireResponse</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-sdc-questionnaireresponse.html\">SDC Standard Questionnaire Response</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>search-type</code><div><p>Allows a user to search for existing completed or partially-completed forms. Generally used to find partially-completed forms for update.</p>\n</div><code>read</code><div><p>Allows retrieval of a specific QuestionnaireResponse by id.</p>\n</div><code>create</code><div><p>Allows recording a completed or partially-completed form</p>\n</div><code>update</code><div><p>Allows updating an existing completed or partially-completed form. (Systems may place rules on who can update forms and under what circumstances.)</p>\n</div><code>delete</code><div><p>Allows removal of a completed form from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove a completed form and under what circumstances.</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>history-instance</code><div><p>Allows review of prior versions of an answer set - allows reversion to previously recorded versions</p>\n</div></li></ul></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"DocumentReference1-5\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>DocumentReference</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/documentreference.html\">DocumentReference</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <br/><code>search-type</code><div><p>Allows discovery of existing documents that may be included in a form pre-population request</p>\n</div></li></ul></div></div><p/><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Binary1-6\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Binary</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/binary.html\">Binary</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <br/><code>read</code><div><p>Allows retrieval of a specific binary (as pointed to by a DocumentReference)</p>\n</div></li><li><strong>MAY</strong> support <br/><code>vread</code><div><p>Allows retrieval of a historical version of a binary. In general, the most recent version would be appropriate, but some may prefer to use the specific version referenced by a DocumentReference.</p>\n</div></li></ul></div></div><p/><p/></div></div></div><h3 id=\"operationsCap1\">Operations</h3><h4 id=\"operationsSummary1\">Use</h4></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "fhir"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 4,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-filler",
  "version" : "4.0.0-ballot",
  "name" : "SDCFormFiller",
  "title" : "SDC Form Filler",
  "status" : "active",
  "date" : "2014-07-06",
  "publisher" : "HL7 International / FHIR Infrastructure",
  "contact" : [
    {
      "name" : "HL7 International / FHIR Infrastructure",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    },
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "description" : "This profile defines the expected capabilities of the ''SDC Form Filler'' role when conforming to the S&I Framework's [[index.html|Structured Data Capture FHIR implementation guide]]. This role is responsible for retrieving pre-defined forms, requesting pre-population of forms and/or auto-populating forms, guiding the user through verifying populated data and submitting completed or partially-completed forms.<br/>Note that Form Fillers may also take on the role of [[CapabilityStatement-sdc-form-archiver.html|Form Archiver]] if they have a requirement to retain the completed version of a form (and potentially the source data that was used to complete it).",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "1.0.0",
  "format" : [
    "xml",
    "json"
  ],
  "rest" : [
    {
      "mode" : "client",
      "documentation" : "The [[Questionnaire]], [[ValueSet]] and [[CodeSystem]] resources are retrieved to allow the system to guide the user through the entry process. The [[Binary]] and [[DocumentReference]] resources allow the system to find existing clinical documents that can be within the pre-population process. (Support for retrieval operations on these resources is optional as the relevant CDA or FHIR structures may also be directly generated by the ''Form Filler'' itself.) Finally, the [[QuestionnaireResponse]] resource is used to record the populated form.<br/>Note: Form Fillers that support the 'populate' operation will need to be capable of consuming and rendering a partially completed QuestionnaireResponse in the same manner as if they had retrieved such a QuestionnaireResponse from a ''Form Response Manager''",
      "security" : {
        "description" : "Implementations must meet the general security requirements documented in the [[security.html|SDC implementation guide]]."
      },
      "resource" : [
        {
          "type" : "Questionnaire",
          "profile" : "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type",
              "documentation" : "Allows discovery of existing questionnaires to be completed"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific questionnaire by id. Allows systems to maintain a 'favorites' list of forms and retrieve them by id."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "history-instance",
              "documentation" : "Allows review of changes made to a questionnaire over time. Of interest to some systems, but probably not most."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "vread",
              "documentation" : "Allows retrieval of a historical version of a questionnaire. Most systems will make use of the current version only."
            }
          ]
        },
        {
          "type" : "ValueSet",
          "profile" : "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific value set by id (as referenced in a Questionnaire)"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread",
              "documentation" : "Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "history-instance",
              "documentation" : "Allows review of changes to a value set over time. Of interest to some systems, but probably not most."
            }
          ]
        },
        {
          "type" : "CodeSystem",
          "profile" : "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific code system by id (as referenced by a ValueSet used in a Questionnaire)"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread",
              "documentation" : "Allows retrieval of a specific version of a code system (as referenced by a ValueSet used in a Questionnaire)"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "history-instance",
              "documentation" : "Allows review of changes to a code system over time. Of interest to some systems, but probably not most."
            }
          ]
        },
        {
          "type" : "QuestionnaireResponse",
          "profile" : "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type",
              "documentation" : "Allows a user to search for existing completed or partially-completed forms. Generally used to find partially-completed forms for update."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific QuestionnaireResponse by id."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "create",
              "documentation" : "Allows recording a completed or partially-completed form"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "update",
              "documentation" : "Allows updating an existing completed or partially-completed form. (Systems may place rules on who can update forms and under what circumstances.)"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "delete",
              "documentation" : "Allows removal of a completed form from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove a completed form and under what circumstances."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "history-instance",
              "documentation" : "Allows review of prior versions of an answer set - allows reversion to previously recorded versions"
            }
          ]
        },
        {
          "type" : "DocumentReference",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "search-type",
              "documentation" : "Allows discovery of existing documents that may be included in a form pre-population request"
            }
          ]
        },
        {
          "type" : "Binary",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific binary (as pointed to by a DocumentReference)"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "vread",
              "documentation" : "Allows retrieval of a historical version of a binary. In general, the most recent version would be appropriate, but some may prefer to use the specific version referenced by a DocumentReference."
            }
          ]
        }
      ],
      "operation" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            }
          ],
          "name" : "expand",
          "definition" : "http://hl7.org/fhir/OperationDefinition/ValueSet-expand"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            }
          ],
          "name" : "validate code",
          "definition" : "http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "MAY"
            }
          ],
          "name" : "populate",
          "definition" : "http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-populate"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "MAY"
            }
          ],
          "name" : "populatehtml",
          "definition" : "http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-populatehtml"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "MAY"
            }
          ],
          "name" : "populatelink",
          "definition" : "http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-populatelink"
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.